Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update TrueNAS Scale instructions for upcoming 24.10 release #1163

Merged
merged 5 commits into from
Oct 28, 2024

Conversation

p0358
Copy link
Contributor

@p0358 p0358 commented Oct 22, 2024

Here's the situation:

  • TrueCharts is no longer supporting TrueNAS SCALE at all, they removed their catalog, now it's 404 and the app installations are basically unsupported
  • Jellyfin is now available in the official app catalog (wasn't at the time these instructions were created)
  • (upcoming TrueNAS Scale 24.10 will replace Kubernetes-based apps with Docker-based apps, but as far as UI is concerned, pretty much nothing is changed when installing apps from official catalogue)

So this PR changes the instructions to simply use the official Jellyfin app that's now available.

The wording is adjusted for the interface of upcoming release of TrueNAS Scale 24.10 that's expected soon in late October (currently in RC), but the general instructions for installing Jellyfin from official app catalog are pretty much the exact same from user perspective in old versions now too. The only practical difference is some wording changes (such as "Available Applications" is now "Discover Apps" , "Open" button is now "Web UI" and "Save" is now "Install"/"Update", nothing that would stop people from going through).

So I think it can be merged as-is without waiting. Especially given TrueCharts instructions are now broken/outdated and the new ones will work more-less for old versions just as well.

@felix920506 felix920506 added future-release Documentation change for a future Jellyfin release and removed future-release Documentation change for a future Jellyfin release labels Oct 22, 2024
docs/general/installation/container.md Outdated Show resolved Hide resolved
docs/general/installation/container.md Show resolved Hide resolved
@p0358
Copy link
Contributor Author

p0358 commented Oct 22, 2024

To clarify the below:

  • Temporary places a Docker volume under your configured Apps dataset (avoid if that's on HDD)

When first setting up Apps section on SCALE, users have to select parent pool where the internal dataset for apps data will be created. So they should know what that is and where I hope...

EDIT: Actually screw it, I'll modify it to say where to check.

docs/general/installation/container.md Outdated Show resolved Hide resolved
docs/general/installation/container.md Outdated Show resolved Hide resolved
@felix920506
Copy link
Member

@nyanmisaka please review the HWA related items

@p0358
Copy link
Contributor Author

p0358 commented Oct 24, 2024

I added forum post here with the question about tmpfs limits: https://forums.truenas.com/t/question-about-tmpfs-mount-for-apps-and-its-memory-limits-in-electric-eel/21473 (but it's a miniscule problem, so I wouldn't hold the whole PR just for this if we don't get a concrete answer)

Btw there's also more thorough instructions at TrueNAS docs themselves for Jellyfin: https://www.truenas.com/docs/truenasapps/communityapps/jellyfin/

We could consider linking them too somewhere at the end maybe? But it's worth noting that the screenshots are based on older TrueNAS release, so they're gonna be a bit outdated compared to ours now.

@felix920506
Copy link
Member

You don't need to force push with every change. We squash when merging.

@p0358
Copy link
Contributor Author

p0358 commented Oct 24, 2024

Fair. Just a habit for situations where there's multiple logically separated commits potentially, but that's not really in docs repo I suppose

@p0358
Copy link
Contributor Author

p0358 commented Oct 25, 2024

  • fixed mention of swap, I learnt that since 24.04 swap is globally disabled by default
  • changed wording to You may need to increase the limit if you have many media files streamed with transcoding at once, or transcodes might fail., since when you think about it, the size of your library doesn't really matter at all, what matters is how many people try to transcode at the same time and what kind of bitrate they're using (the latter largely boiling down to whether they stream from LAN or WAN since autodetection)

But now that I think about it, large media files might result in larger default bitrate selected and thus also more storage needed by default. Hmm, maybe I should re-add the "large" word then. Let me know if I should please, because I'm actually not sure how much the original file size influences the automatic bitrate...

As for the Docker memory usage limit, I got a response on the forums post:

We’ve had some internal discussion about it, but ultimately anything I say about the tmpfs behavior would be a guess. As you’ve seen, Docker docs aren’t very helpful on the subject and looking around online I’ve seen both things saying that the tmpfs mount is and is not limited by the overall container restrictions.

Since we’re passing through default docker behavior there, I think the best bet barring extensive testing is to reach out to the docker devs and try to get an answer from the source.

But Docker devs were kinda silent about it on the posts I found on their forums. So for now I'd just leave that cautious sentence there, and it could be revisited in case the problem comes up for someone and they'll find out empirically:

Note that total memory usage may also be capped in the Resources Configuration section.

@felix920506
Copy link
Member

Single large files and many small files at the same time can both cause problems with transcode directory filling up. so the large files should be added back.

Copy link
Member

@felix920506 felix920506 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good enough for now

Copy link
Contributor

@Gauvino Gauvino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Little typo over-all it's great

docs/general/installation/container.md Outdated Show resolved Hide resolved
Co-authored-by: Gauvain Perchey <[email protected]>
@jellyfin-bot
Copy link

Cloudflare Pages deployment

Latest commit a17e5f0b5379d99b2705b93fd6a58a0480c691b9
Status ✅ Deployed!
Preview URL https://7097fd41.jellyfin-org.pages.dev
Type 🔀 Preview

@felix920506 felix920506 merged commit 72a1abe into jellyfin:master Oct 28, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants